home *** CD-ROM | disk | FTP | other *** search
/ PD ROM 1 / PD ROM Volume I - Macintosh Software from BMUG (1988).iso / Programming / Complete Applications / MEdit 1.5 / Read me first < prev    next >
Encoding:
Text File  |  1986-11-07  |  11.0 KB  |  268 lines  |  [TEXT/ttxt]
  1.  
  2.  
  3. Hello,
  4.  
  5. thanks for your interest in the MEdit source files. You find them on this
  6. disk. If you should find any bugs, inefficiencies or if you have added a
  7. new feature to MEdit you would like make available to other users, send
  8. it to me on a disk. You will get the disk back with the latest version
  9. of MEdit (including source files). Please do not release new versions of
  10. MEdit yourself because this could lead to an uncontrollable number of
  11. different versions.
  12.  
  13. Note that you may not copy the source code, in whole or part, for
  14. distribution. However you may make backup copies or write new programs
  15. or versions of MEdit based on this source.
  16.  
  17. The binary code of MEdit may be given away freely, but it may not be sold.
  18. Please always include the files 'Macros.mcr', 'Macros', 'MComp' and
  19. 'MEdit.doc'.
  20.  
  21. The version of MEdit you get on this Disk is 1.4D20. This is still a pre-
  22. release even if I feel quite comfortable with it. The updated documentation
  23. uses 124 kByte of disk space. It couldn't be included for this reason. But
  24. the following list of changes / additions should help you to take
  25. advantage of all the new capabilities:
  26.  
  27. - There is now a compiler which has to be used to be able to run a macro
  28.   file under MEdit. The new concept has several advantages:
  29.  
  30.     • compiled macros are more compact -> less disk space used
  31.     • compiled macros can be loaded much faster -> faster MEdit startup
  32.     • the new editor without parser is 3 kByte smaller -> new features
  33.     • the new editor needs less data space
  34.     • the compiler allows better syntax checking and error messages
  35.     • compiled macros run faster -> faster execution of macros
  36.  
  37.   Switching forth and back between the editor and the compiler is quite
  38.   fast, so macro development isn't really more complicated than before.
  39.   Use of the MComp (the macro compiler) is straight forward: Start it,
  40.   choose 'Compile' from the 'File' menu, choose the macro text file
  41.   (which has to have a name ending in '.mcr'). As long as the spinning
  42.   wheel is turning, the compiler is working. The output file will have
  43.   the same name as the input file but without '.mcr'. The compiled file
  44.   is now ready to be used with MEdit.
  45.  
  46. - MEdit can now handle files of any length. It does so by means of
  47.   sections. In the Open dialog box you may set the section size (press
  48.   the set size button). If you read a file from disk it will be splitted
  49.   into sections of this size (there is an automatic adjustment to prevent
  50.   lines or words from being broken across sections). Above and below the
  51.   scroll bar there are two buttons which allow you to switch between the
  52.   sections. The number of the current section is displayed in the upper
  53.   button. The lower button is normally empty but if you are working in
  54.   the last section it will display the letter "N" which stands for New.
  55.   So if you press this button in this case a new section will be added
  56.   at the end of the file. To make section switching easy, there are two
  57.   new macro commands (see below) which allow you to implement whatever
  58.   is convenient for you.
  59.  
  60. - There are three new macro commands and four new functions:
  61.  
  62.   • WINDOW(<num-expr>); changes the active window during macro execution.
  63.     This allows for example to hold the glossary data ("Glossary macro
  64.     in Demo.mcr") in it's own window / file. An other example would be
  65.     a "global search", which searches for all occurences of a string in
  66.     all open windows. Or a macro which searches for the PROCEDURE defini-
  67.     tion in all open library files,...
  68.     Windows are numbered from 0 to n, from front to back.
  69.  
  70.   • APPEND; Appends a new empty section at the end of a file and makes
  71.     it the current section. This may be useful if you need a temporary
  72.     buffer to hold some data while a macro is running. To avoid that this
  73.     data will be written back to disk together with the "real" data, just
  74.     delete the temporary data with select(0,0 | L$,C$); clear;.
  75.  
  76.   • SECT(<num-expr>); changes the current section. See "Jump to Section"
  77.     macro in Macros.mcr.
  78.     Sections are numbered from 0 to n.
  79.  
  80.   • STRCMP(<str-val1>, <str-val2>, <num-expr>); This new function which
  81.     replaces the boolean function STREQU compares the two string values
  82.     and returns -1, 0, 1 depending on the result. If <str-val1> is smaller
  83.     than <str-val2> the return value is -1, if it's equal it is 0, and
  84.     if it's greater it is 1. So to write the equivalent of
  85.  
  86.         IF STREQU($1, $2, 0) { ....
  87.  
  88.     you will have to write
  89.  
  90.         IF STRCMP($1, $2, 0) = 0 { ...
  91.  
  92.     The <num-expr> parameter tells whether or not to distinguish between
  93.     upper and lower case characters.
  94.  
  95.   • LEN(<str-val>); returns the length of the string specified.
  96.  
  97.   • CONCAT(<str-val> {,<str-val>}); concatenates all specified strings.
  98.  
  99.   • SUBSTR(<str-val>, <num-expr1>, <num-expr2); extracts the substring
  100.     starting at <num-expr1> and with length <num-expr2> from <str-val>.
  101.     If <num-expr2> is negative, characters to the left are extacted.
  102.  
  103. - There are two new meta values for sections:
  104.  
  105.     S.  ->  number of the current section
  106.     S$  ->  number of the last section
  107.  
  108. - The macro commands FIND, WINDOW and SECT can be used as boolean
  109.   functions now:
  110.  
  111.     WINDOW will switch the active window. If it finds the specified window
  112.     it will return TRUE otherwise it returns FALSE. (see "Window test"
  113.     macro in Demo.mcr).
  114.  
  115.     SECT will switch the active section. If it finds the specified section
  116.     it will return TRUE otherwise it returns FALSE.
  117.  
  118.     FIND searches for a given string from the current cursor position.
  119.     If it finds the string it selects it and returns TRUE. Otherwise
  120.     it doesn't change the current position (note that this has changed from
  121.     earlier versions of MEdit, which set the position to start of window
  122.     if the string wasn't found) and returns FALSE. (see "Replace tabs"
  123.     macro in Macros.mcr).
  124.  
  125.   If WINDOWS or SECT are not used as boolean functions (i.e. just as a
  126.   freestanding command like 'WINDOW(0);') they don't return anything but
  127.   if the switching failed an appropriate dialog box will be displayed
  128.   and the macro execution stops. If FIND is used outside a boolean
  129.   expression and does not find the given string, it does nothing.
  130.  
  131. - The macro syntax has been somewhat simplified: where ever you had to
  132.   write a command list enclosed by { and } you may now write just a
  133.   command. This is now consistent with most higher level languages.
  134.   Example:
  135.  
  136.             IF #0 < 3 {
  137.                 FIND("xyz");
  138.             } ELSE {
  139.                 SELECT(0,0);
  140.             };
  141.  
  142.   can now be written as
  143.  
  144.             IF #0 < 3
  145.                 FIND("xyz")
  146.             ELSE
  147.                 SELECT(0,0);
  148.  
  149.   Of course you will still have to use a command list if you want to
  150.   execute more than one command after IF, ELSE or WHILE. The commands
  151.   of a whole macro still have to be surrounded by { and }.
  152.  
  153. - Anyone of the macros of a macro file can now be made autoexecuted when
  154.   the file is being loaded. Syntax: preceed the autostart macro by '!'.
  155.   If you use commands which have to run on a text window you will have
  156.   to make shure that such a window exists. If you autoexecute a macro
  157.   which uses text commands and the current window is not a text window,
  158.   MEdit will bomb immediately.
  159.  
  160.     * go to end of active window, whenever this macro is loaded
  161.     * and the front window is a text window
  162.  
  163.     ! "Bottom" {
  164.         IF WINDOW(0)
  165.             Select($,$)!;
  166.     };
  167.  
  168.  
  169. - It is now possible to "index" variables: #(3+5) for example means the
  170.   numeric variable #8. $(#3) selects one of the string variables depending
  171.   on the content of #3.
  172.  
  173.     "Var test" {
  174.         Set(#0, 3);
  175.         Set(#3, -999);
  176.         Prompt("Is it -999 ?", #(#0));
  177.     };
  178.  
  179. - The Transfer menu is now auto-configuring, i.e. it will remember the
  180.   last five applications which have been called. This way it's possible
  181.   to call them directly (without SFGetFile). Only applications in the
  182.   same directory as MEdit can be called this way.
  183.  
  184. - A bug which occured sometimes with double-strike characters has been
  185.   fixed
  186.  
  187. - If you tried to 'Quit' or 'Transfer' and had open windows which had to
  188.   be saved, but a disk error occured (e.g. 'Disk Locked') the windows were
  189.   closed anyway. The result of this situation was sometimes lost data. This
  190.   problem is fixed now. The window is kept open after an error to give you
  191.   one more chance to save it correctly.
  192.  
  193. - Auto indent is now toggled with the shift key (instead of just being
  194.   switched off as before).
  195.  
  196. - Pressing the space bar while a macro is running slows execution down
  197.   for debugging.
  198.  
  199. - While running a macro the cursor will now change to a spinning wheel.
  200.  
  201. - The '<' and '>' metacharacters have been modfied to allow you to jump
  202.   from one word to the next (forward and backward). If no word is found
  203.   on the current line, -1 is returned. The examples "prev Word",
  204.   "next Word" and "current Word" macros in the file Demo.mcr are *not*
  205.   updated!
  206.  
  207. - "Show invisibles" has been added to the Options menu.
  208.  
  209. - Under macro control the dirty flag is now always set correctly.
  210.  
  211. - 'INSERT(<str-expr>)' was in fact 'INSERT(<str-expr>)!'. This has been
  212.   changed. -> The 'replace tabs' macro now runs faster, because it doesn't
  213.   have to update the screen all the time.
  214.  
  215. - negative constants are now possible.
  216.  
  217. - The use of \ and " in a string is now possible.
  218.  
  219. - The buttons of the Search dialog box are now updated correctly if you
  220.   cut, clear and paste in the edit fields.
  221.  
  222. - Printing multiple copies and 'from/to page' now works correctly.
  223.  
  224. - '-------' items in the Macros menu are now always disabled.
  225.  
  226.  
  227. IMPORTANT NOTE: Earlier I stated that the KeyCode DA should be installed
  228.                 within MEdit. Unfortunately the Font/DA Mover doesn't
  229.                 check the DRVR numbers of the DA's in the System
  230.                 file. That's why it is possible that it gives the "local"
  231.                 DA a DRVR number which is already used. The result are
  232.                 mixed up resources -> bombs. So don't install DA's directly
  233.                 in a programm unless you are shure the DRVR numbers are
  234.                 ok with any (!) system you use with this program.
  235.  
  236.  
  237.  
  238. This is MEdit version 1.5. For all those who don't know MEdit, it is a user programmable text editor which you can configure for your specific editing
  239. tasks.
  240.  
  241. The new version has many enhancements and bug fixes. Here are some of the most important changes:
  242.  
  243. - Macros are compiled now. This allows much faster loading and reduces
  244.   the size by about 80%. Syntax checking and error messages have been
  245.   improved.
  246.  
  247. - MEdit can now handle files of arbitrary size, as long as there is
  248.   enough memory. It does so by splitting the file into sections which
  249.   can be switched by buttons in the scroll bar.
  250.  
  251. - There are some new macro commands: SUBSTR, WINDOW, STRCMP, LEN, and
  252.   CONCAT. The macro syntax has been somewhat simplified.
  253.  
  254. - Real tabs are supported now.
  255.  
  256. - "Show invisibles" has been added.
  257.  
  258. - ...
  259.  
  260.  
  261. Note: The manual has been revised in MacWrite for US Letter size paper. It was international paper. 9/16/86 D. Bak
  262.  
  263.  
  264. You are encouraged to upload the files to any bulletin board you like.
  265. I hope you will like the new version.
  266.  
  267. Matthias Aebi
  268.